@guidepup/guidepup
Advanced tools
Screen-reader driver for automation.
Providing a reliable set of APIs to automate your screen-reader a11y workflows through JavaScript.
Setup your environment for screen-reader automation with @guidepup/setup:
npx @guidepup/setup
Install Guidepup to your project:
npm install @guidepup/guidepup
And get cracking with your first screen-reader automation code! 🚀
import { voiceOver } from "@guidepup/guidepup";
async function run(): Promise<void> {
// Start your screen-reader instance 🎉
await voiceOver.start();
// Navigate your environment with screen-readers just as your users do 🏎
await voiceOver.next();
// Assert on what your users really see and hear when using screen-readers 👂
console.log(await voiceOver.lastSpokenPhrase());
await voiceOver.stop();
}
run();
Check out these fab guides on how to set up your local or CI environments for using Guidepup.
Check out these awesome examples to learn how you could use Guidepup in your projects.
The API documentation has all the information you need to write fantastic screen-reader driven workflows.
Check out some of the other Guidepup modules:
If you are using GitHub Actions, check out the dedicated guidepup/setup-action to setup your CI ready for screen-reader automation.
- name: Setup Environment
uses: guidepup/setup-action@0.5.0
Screen-reader support:
Environment support:
Building on the shoulders of giants! 🙌
Here are some related projects:
FAQs
Screen reader driver for test automation.
The npm package @guidepup/guidepup receives a total of 3,039 weekly downloads. As such, @guidepup/guidepup popularity was classified as popular.
We found that @guidepup/guidepup demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Bun 1.2 enhances its JavaScript runtime with 90% Node.js compatibility, built-in S3 and Postgres support, HTML Imports, and faster, cloud-first performance.
Security News
Biden's executive order pushes for AI-driven cybersecurity, software supply chain transparency, and stronger protections for federal and open source systems.
Security News
Fluent Assertions is facing backlash after dropping the Apache license for a commercial model, leaving users blindsided and questioning contributor rights.